Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: moving how-to readme to root #31

Merged
merged 3 commits into from
Apr 29, 2024
Merged

doc: moving how-to readme to root #31

merged 3 commits into from
Apr 29, 2024

Conversation

simojo
Copy link
Collaborator

@simojo simojo commented Apr 29, 2024

Description

This PR moves the documentation from bosco/ into the root that covers how to run the tool.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to
    not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please briefly write the names of the added tests to test your functionality.

  • This PR does not need tested

@simojo simojo marked this pull request as ready for review April 29, 2024 01:21
Copy link
Collaborator

@PCain02 PCain02 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Collaborator

@PCain02 PCain02 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh nevermind the command changed a little bit to look more like this
poetry run bosco --starting-size 100 --number-doubles 5 --file bosco/sorting.py --function-name bubble_sort --element-type str so that needs updated - more specifically I am talking about the example output

@simojo
Copy link
Collaborator Author

simojo commented Apr 29, 2024

Oh nevermind the command changed a little bit to look more like this poetry run bosco --starting-size 100 --number-doubles 5 --file bosco/sorting.py --function-name bubble_sort --element-type str so that needs updated - more specifically I am talking about the example output

This is fixed.

Copy link
Collaborator

@PCain02 PCain02 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing the example!

Copy link
Collaborator

@AlishChhetri AlishChhetri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for quickly addressing this change!

@simojo simojo merged commit e3b4575 into main Apr 29, 2024
0 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants